Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add events to receipt object #6410

Merged
merged 19 commits into from
Sep 21, 2023
Merged

Add events to receipt object #6410

merged 19 commits into from
Sep 21, 2023

Conversation

avkos
Copy link
Contributor

@avkos avkos commented Sep 8, 2023

Description

Please include a summary of the changes and be sure to follow our Contribution Guidelines.

Fixes #6312

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • I have selected the correct base branch.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • Any dependent changes have been merged and published in downstream modules.
  • I ran npm run lint with success and extended the tests and types if necessary.
  • I ran npm run test:unit with success.
  • I ran npm run test:coverage and my test cases cover all the lines and branches of the added code.
  • I ran npm run build and tested dist/web3.min.js in a browser.
  • I have tested my code on the live network.
  • I have checked the Deploy Preview and it looks correct.
  • I have updated the CHANGELOG.md file in the root folder.
  • I have linked Issue(s) with this PR in "Linked Issues" menu.

@avkos avkos self-assigned this Sep 8, 2023
@avkos avkos added the 4.x 4.0 related label Sep 8, 2023
@github-actions
Copy link

github-actions bot commented Sep 8, 2023 •
edited
Loading

Bundle Stats

Hey there, this message comes from a github action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Asset Old size New size Diff Diff %
Total 655 KB 657 KB 2.04 KB 0.31%
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

Asset Old size New size Diff Diff %
web3.min.js 638 KB 640 KB 2.04 KB 0.32%
../lib/commonjs/index.d.ts 8.56 KB 8.56 KB 0 0.00%
../lib/commonjs/accounts.d.ts 3.67 KB 3.67 KB 0 0.00%
../lib/commonjs/types.d.ts 2.45 KB 2.45 KB 0 0.00%
../lib/commonjs/web3.d.ts 1.14 KB 1.14 KB 0 0.00%
../lib/commonjs/abi.d.ts 1000 bytes 1000 bytes 0 0.00%
../lib/commonjs/eth.exports.d.ts 280 bytes 280 bytes 0 0.00%
../lib/commonjs/providers.exports.d.ts 148 bytes 148 bytes 0 0.00%
../lib/commonjs/version.d.ts 60 bytes 60 bytes 0 0.00%

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Sep 8, 2023 •
edited
Loading

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: abd7870
Status: ✅  Deploy successful!
Preview URL: https://577cd692.web3-js-docs.pages.dev
Branch Preview URL: https://ok-6312-the-returned-logs-of.web3-js-docs.pages.dev

View logs

@codecov
Copy link

codecov bot commented Sep 8, 2023 •
edited
Loading

Codecov Report

Merging #6410 (abd7870) into 4.x (2b445bf) will increase coverage by 0.72%.
Report is 1 commits behind head on 4.x.
The diff coverage is 93.75%.

Additional details and impacted files 
@@            Coverage Diff             @@
##              4.x    #6410      +/-   ##
==========================================
+ Coverage   89.15%   89.88%   +0.72%     
==========================================
  Files         199      201       +2     
  Lines        7756     7779      +23     
  Branches     2147     2129      -18     
==========================================
+ Hits         6915     6992      +77     
+ Misses        841      787      -54
Flag Coverage Δ
UnitTests 89.88% <93.75%> (+0.72%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
web3 ∅ <ø> (∅)
web3-core ∅ <ø> (∅)
web3-errors ∅ <ø> (∅)
web3-eth ∅ <ø> (∅)
web3-eth-abi ∅ <ø> (∅)
web3-eth-accounts ∅ <ø> (∅)
web3-eth-contract ∅ <ø> (∅)
web3-eth-ens ∅ <ø> (∅)
web3-eth-iban ∅ <ø> (∅)
web3-eth-personal ∅ <ø> (∅)
web3-net ∅ <ø> (∅)
web3-providers-http ∅ <ø> (∅)
web3-providers-ipc ∅ <ø> (∅)
web3-providers-ws ∅ <ø> (∅)
web3-rpc-methods ∅ <ø> (∅)
web3-utils ∅ <ø> (∅)
web3-validator ∅ <ø> (∅)

@avkos avkos requested a review from jdevcs September 15, 2023 01:40
@luu-alex
Copy link
Contributor

Looks like codecov is failing

jdevcs
jdevcs reviewed Sep 18, 2023
View reviewed changes
Copy link
Contributor

@jdevcs jdevcs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pls there should be e2e tests for tx having receipt.events present for contract.send, and also not present ( for simple tx ) with geth.

@luu-alex
Copy link
Contributor

other than junaids comment, lgtm 👍

@avkos avkos requested a review from jdevcs September 19, 2023 15:03
@avkos
Copy link
Contributor Author

avkos commented Sep 19, 2023

pls there should be e2e tests for tx having receipt.events present for contract.send, and also not present ( for simple tx ) with geth.

done

Muhammad-Altabba
Muhammad-Altabba requested changes Sep 21, 2023
View reviewed changes
Copy link
Contributor

@Muhammad-Altabba Muhammad-Altabba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @avkos , this seems good.
However, still args are not filled. According to the raised issue: #6312

(The returned log does not include the properties: event and args)

I am not sure about the exact properties of those args. It needs to be checked against 1.x. But they seem to be used to access at least args.eventID, args._from, args.num (See here https://github.com/nazarhussain/truffle/blob/656263aadf21612b17829483d7376eb7afbe63aa/packages/artifactor/test/contracts.js#L242 and https://github.com/nazarhussain/truffle/blob/656263aadf21612b17829483d7376eb7afbe63aa/packages/deployer/test/await.js#L134-L135)
Or what do you think?

@avkos
Copy link
Contributor Author

avkos commented Sep 21, 2023

Thanks @avkos , this seems good. However, still args are not filled. According to the raised issue: #6312

(The returned log does not include the properties: event and args)

I am not sure about the exact properties of those args. It needs to be checked against 1.x. But they seem to be used to access at least args.eventID, args._from, args.num (See here https://github.com/nazarhussain/truffle/blob/656263aadf21612b17829483d7376eb7afbe63aa/packages/artifactor/test/contracts.js#L242 and https://github.com/nazarhussain/truffle/blob/656263aadf21612b17829483d7376eb7afbe63aa/packages/deployer/test/await.js#L134-L135) Or what do you think?

here is a web3js@1.x response
image

it doesn't have any args field. Looks like. truffle added it inside the library

@avkos
Copy link
Contributor Author

avkos commented Sep 21, 2023 •
edited
Loading

just for your information here is web3js@4.x response
image

we have logs and events fields

@avkos avkos merged commit 171b413 into 4.x Sep 21, 2023
61 of 65 checks passed
@avkos avkos deleted the ok/6312-The-returned-logs-of-a-contract-event-are-not-of-an-event-object branch September 21, 2023 15:00
@jdevcs jdevcs mentioned this pull request Oct 18, 2023
Merged
@blukat29 blukat29 mentioned this pull request Dec 26, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jdevcs jdevcs jdevcs approved these changes

@luu-alex luu-alex luu-alex approved these changes

@Muhammad-Altabba Muhammad-Altabba Muhammad-Altabba approved these changes

Assignees

@avkos avkos

Labels
4.x 4.0 related
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

The returned logs of a contract event are not of an event object
4 participants
@avkos @luu-alex @Muhammad-Altabba @jdevcs